1. HashMap简介

HashMap是基于哈希表实现的,每一个元素都是一个key-value对,其内部通过单链表解决冲突问题,容量不足(超过了阈值)时,同样会自动增长。

HashMap是非线程安全的,只是用于单线程环境下,多线程环境下可以采用concurrent并发包下的concurrentHashMap。

HashMap实现了Serializable接口,因此它支持序列化,实现了Cloneable接口,能被克隆。

2. HashMap源码剖析

HashMap的源码如下(加入了比较详细的注释):

  1. package java.util;
  2. import java.io.*;
  3. public class HashMap<K,V>
  4. extends AbstractMap<K,V>
  5. implements Map<K,V>, Cloneable, Serializable
  6. {
  7. // 默认的初始容量(容量为HashMap中槽的数目)是16,且实际容量必须是2的整数次幂。
  8. static final int DEFAULT_INITIAL_CAPACITY = 16;
  9. // 最大容量(必须是2的幂且小于2的30次方,传入容量过大将被这个值替换)
  10. static final int MAXIMUM_CAPACITY = 1 << 30;
  11. // 默认加载因子为0.75
  12. static final float DEFAULT_LOAD_FACTOR = 0.75f;
  13. // 存储数据的Entry数组,长度是2的幂。
  14. // HashMap采用链表法解决冲突,每一个Entry本质上是一个单向链表
  15. transient Entry[] table;
  16. // HashMap的底层数组中已用槽的数量
  17. transient int size;
  18. // HashMap的阈值,用于判断是否需要调整HashMap的容量(threshold = 容量*加载因子)
  19. int threshold;
  20. // 加载因子实际大小
  21. final float loadFactor;
  22. // HashMap被改变的次数
  23. transient volatile int modCount;
  24. // 指定“容量大小”和“加载因子”的构造函数
  25. public HashMap(int initialCapacity, float loadFactor) {
  26. if (initialCapacity < 0)
  27. throw new IllegalArgumentException("Illegal initial capacity: " +
  28. initialCapacity);
  29. // HashMap的最大容量只能是MAXIMUM_CAPACITY
  30. if (initialCapacity > MAXIMUM_CAPACITY)
  31. initialCapacity = MAXIMUM_CAPACITY;
  32. //加载因此不能小于0
  33. if (loadFactor <= 0 || Float.isNaN(loadFactor))
  34. throw new IllegalArgumentException("Illegal load factor: " + loadFactor);
  35. // 找出“大于initialCapacity”的最小的2的幂
  36. int capacity = 1;
  37. while (capacity < initialCapacity)
  38. capacity <<= 1;
  39. // 设置“加载因子”
  40. this.loadFactor = loadFactor;
  41. // 设置“HashMap阈值”,当HashMap中存储数据的数量达到threshold时,就需要将HashMap的容量加倍。
  42. threshold = (int)(capacity * loadFactor);
  43. // 创建Entry数组,用来保存数据
  44. table = new Entry[capacity];
  45. init();
  46. }
  47. // 指定“容量大小”的构造函数
  48. public HashMap(int initialCapacity) {
  49. this(initialCapacity, DEFAULT_LOAD_FACTOR);
  50. }
  51. // 默认构造函数。
  52. public HashMap() {
  53. // 设置“加载因子”为默认加载因子0.75
  54. this.loadFactor = DEFAULT_LOAD_FACTOR;
  55. // 设置“HashMap阈值”,当HashMap中存储数据的数量达到threshold时,就需要将HashMap的容量加倍。
  56. threshold = (int)(DEFAULT_INITIAL_CAPACITY * DEFAULT_LOAD_FACTOR);
  57. // 创建Entry数组,用来保存数据
  58. table = new Entry[DEFAULT_INITIAL_CAPACITY];
  59. init();
  60. }
  61. // 包含“子Map”的构造函数
  62. public HashMap(Map<? extends K, ? extends V> m) {
  63. this(Math.max((int) (m.size() / DEFAULT_LOAD_FACTOR) + 1,
  64. DEFAULT_INITIAL_CAPACITY), DEFAULT_LOAD_FACTOR);
  65. // 将m中的全部元素逐个添加到HashMap中
  66. putAllForCreate(m);
  67. }
  68. //求hash值的方法,重新计算hash值
  69. static int hash(int h) {
  70. h ^= (h >>> 20) ^ (h >>> 12);
  71. return h ^ (h >>> 7) ^ (h >>> 4);
  72. }
  73. // 返回h在数组中的索引值,这里用&代替取模,旨在提升效率
  74. // h & (length-1)保证返回值的小于length
  75. static int indexFor(int h, int length) {
  76. return h & (length-1);
  77. }
  78. public int size() {
  79. return size;
  80. }
  81. public boolean isEmpty() {
  82. return size == 0;
  83. }
  84. // 获取key对应的value
  85. public V get(Object key) {
  86. if (key == null)
  87. return getForNullKey();
  88. // 获取key的hash值
  89. int hash = hash(key.hashCode());
  90. // 在“该hash值对应的链表”上查找“键值等于key”的元素
  91. for (Entry<K,V> e = table[indexFor(hash, table.length)];
  92. e != null;
  93. e = e.next) {
  94. Object k;
  95. //判断key是否相同
  96. if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
  97. return e.value;
  98. }
  99. //没找到则返回null
  100. return null;
  101. }
  102. // 获取“key为null”的元素的值
  103. // HashMap将“key为null”的元素存储在table[0]位置,但不一定是该链表的第一个位置!
  104. private V getForNullKey() {
  105. for (Entry<K,V> e = table[0]; e != null; e = e.next) {
  106. if (e.key == null)
  107. return e.value;
  108. }
  109. return null;
  110. }
  111. // HashMap是否包含key
  112. public boolean containsKey(Object key) {
  113. return getEntry(key) != null;
  114. }
  115. // 返回“键为key”的键值对
  116. final Entry<K,V> getEntry(Object key) {
  117. // 获取哈希值
  118. // HashMap将“key为null”的元素存储在table[0]位置,“key不为null”的则调用hash()计算哈希值
  119. int hash = (key == null) ? 0 : hash(key.hashCode());
  120. // 在“该hash值对应的链表”上查找“键值等于key”的元素
  121. for (Entry<K,V> e = table[indexFor(hash, table.length)];
  122. e != null;
  123. e = e.next) {
  124. Object k;
  125. if (e.hash == hash &&
  126. ((k = e.key) == key || (key != null && key.equals(k))))
  127. return e;
  128. }
  129. return null;
  130. }
  131. // 将“key-value”添加到HashMap中
  132. public V put(K key, V value) {
  133. // 若“key为null”,则将该键值对添加到table[0]中。
  134. if (key == null)
  135. return putForNullKey(value);
  136. // 若“key不为null”,则计算该key的哈希值,然后将其添加到该哈希值对应的链表中。
  137. int hash = hash(key.hashCode());
  138. int i = indexFor(hash, table.length);
  139. for (Entry<K,V> e = table[i]; e != null; e = e.next) {
  140. Object k;
  141. // 若“该key”对应的键值对已经存在,则用新的value取代旧的value。然后退出!
  142. if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
  143. V oldValue = e.value;
  144. e.value = value;
  145. e.recordAccess(this);
  146. return oldValue;
  147. }
  148. }
  149. // 若“该key”对应的键值对不存在,则将“key-value”添加到table中
  150. modCount++;
  151. // 将key-value添加到table[i]处
  152. addEntry(hash, key, value, i);
  153. return null;
  154. }
  155. // putForNullKey()的作用是将“key为null”键值对添加到table[0]位置
  156. private V putForNullKey(V value) {
  157. for (Entry<K,V> e = table[0]; e != null; e = e.next) {
  158. if (e.key == null) {
  159. V oldValue = e.value;
  160. e.value = value;
  161. e.recordAccess(this);
  162. return oldValue;
  163. }
  164. }
  165. // 如果没有存在key为null的键值对,则直接题阿见到table[0]处!
  166. modCount++;
  167. addEntry(0, null, value, 0);
  168. return null;
  169. }
  170. // 创建HashMap对应的“添加方法”,
  171. // 它和put()不同。putForCreate()是内部方法,它被构造函数等调用,用来创建HashMap
  172. // 而put()是对外提供的往HashMap中添加元素的方法。
  173. private void putForCreate(K key, V value) {
  174. int hash = (key == null) ? 0 : hash(key.hashCode());
  175. int i = indexFor(hash, table.length);
  176. // 若该HashMap表中存在“键值等于key”的元素,则替换该元素的value值
  177. for (Entry<K,V> e = table[i]; e != null; e = e.next) {
  178. Object k;
  179. if (e.hash == hash &&
  180. ((k = e.key) == key || (key != null && key.equals(k)))) {
  181. e.value = value;
  182. return;
  183. }
  184. }
  185. // 若该HashMap表中不存在“键值等于key”的元素,则将该key-value添加到HashMap中
  186. createEntry(hash, key, value, i);
  187. }
  188. // 将“m”中的全部元素都添加到HashMap中。
  189. // 该方法被内部的构造HashMap的方法所调用。
  190. private void putAllForCreate(Map<? extends K, ? extends V> m) {
  191. // 利用迭代器将元素逐个添加到HashMap中
  192. for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
  193. Map.Entry<? extends K, ? extends V> e = i.next();
  194. putForCreate(e.getKey(), e.getValue());
  195. }
  196. }
  197. // 重新调整HashMap的大小,newCapacity是调整后的容量
  198. void resize(int newCapacity) {
  199. Entry[] oldTable = table;
  200. int oldCapacity = oldTable.length;
  201. //如果就容量已经达到了最大值,则不能再扩容,直接返回
  202. if (oldCapacity == MAXIMUM_CAPACITY) {
  203. threshold = Integer.MAX_VALUE;
  204. return;
  205. }
  206. // 新建一个HashMap,将“旧HashMap”的全部元素添加到“新HashMap”中,
  207. // 然后,将“新HashMap”赋值给“旧HashMap”。
  208. Entry[] newTable = new Entry[newCapacity];
  209. transfer(newTable);
  210. table = newTable;
  211. threshold = (int)(newCapacity * loadFactor);
  212. }
  213. // 将HashMap中的全部元素都添加到newTable中
  214. void transfer(Entry[] newTable) {
  215. Entry[] src = table;
  216. int newCapacity = newTable.length;
  217. for (int j = 0; j < src.length; j++) {
  218. Entry<K,V> e = src[j];
  219. if (e != null) {
  220. src[j] = null;
  221. do {
  222. Entry<K,V> next = e.next;
  223. int i = indexFor(e.hash, newCapacity);
  224. e.next = newTable[i];
  225. newTable[i] = e;
  226. e = next;
  227. } while (e != null);
  228. }
  229. }
  230. }
  231. // 将"m"的全部元素都添加到HashMap中
  232. public void putAll(Map<? extends K, ? extends V> m) {
  233. // 有效性判断
  234. int numKeysToBeAdded = m.size();
  235. if (numKeysToBeAdded == 0)
  236. return;
  237. // 计算容量是否足够,
  238. // 若“当前阀值容量 < 需要的容量”,则将容量x2。
  239. if (numKeysToBeAdded > threshold) {
  240. int targetCapacity = (int)(numKeysToBeAdded / loadFactor + 1);
  241. if (targetCapacity > MAXIMUM_CAPACITY)
  242. targetCapacity = MAXIMUM_CAPACITY;
  243. int newCapacity = table.length;
  244. while (newCapacity < targetCapacity)
  245. newCapacity <<= 1;
  246. if (newCapacity > table.length)
  247. resize(newCapacity);
  248. }
  249. // 通过迭代器,将“m”中的元素逐个添加到HashMap中。
  250. for (Iterator<? extends Map.Entry<? extends K, ? extends V>> i = m.entrySet().iterator(); i.hasNext(); ) {
  251. Map.Entry<? extends K, ? extends V> e = i.next();
  252. put(e.getKey(), e.getValue());
  253. }
  254. }
  255. // 删除“键为key”元素
  256. public V remove(Object key) {
  257. Entry<K,V> e = removeEntryForKey(key);
  258. return (e == null ? null : e.value);
  259. }
  260. // 删除“键为key”的元素
  261. final Entry<K,V> removeEntryForKey(Object key) {
  262. // 获取哈希值。若key为null,则哈希值为0;否则调用hash()进行计算
  263. int hash = (key == null) ? 0 : hash(key.hashCode());
  264. int i = indexFor(hash, table.length);
  265. Entry<K,V> prev = table[i];
  266. Entry<K,V> e = prev;
  267. // 删除链表中“键为key”的元素
  268. // 本质是“删除单向链表中的节点”
  269. while (e != null) {
  270. Entry<K,V> next = e.next;
  271. Object k;
  272. if (e.hash == hash &&
  273. ((k = e.key) == key || (key != null && key.equals(k)))) {
  274. modCount++;
  275. size--;
  276. if (prev == e)
  277. table[i] = next;
  278. else
  279. prev.next = next;
  280. e.recordRemoval(this);
  281. return e;
  282. }
  283. prev = e;
  284. e = next;
  285. }
  286. return e;
  287. }
  288. // 删除“键值对”
  289. final Entry<K,V> removeMapping(Object o) {
  290. if (!(o instanceof Map.Entry))
  291. return null;
  292. Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
  293. Object key = entry.getKey();
  294. int hash = (key == null) ? 0 : hash(key.hashCode());
  295. int i = indexFor(hash, table.length);
  296. Entry<K,V> prev = table[i];
  297. Entry<K,V> e = prev;
  298. // 删除链表中的“键值对e”
  299. // 本质是“删除单向链表中的节点”
  300. while (e != null) {
  301. Entry<K,V> next = e.next;
  302. if (e.hash == hash && e.equals(entry)) {
  303. modCount++;
  304. size--;
  305. if (prev == e)
  306. table[i] = next;
  307. else
  308. prev.next = next;
  309. e.recordRemoval(this);
  310. return e;
  311. }
  312. prev = e;
  313. e = next;
  314. }
  315. return e;
  316. }
  317. // 清空HashMap,将所有的元素设为null
  318. public void clear() {
  319. modCount++;
  320. Entry[] tab = table;
  321. for (int i = 0; i < tab.length; i++)
  322. tab[i] = null;
  323. size = 0;
  324. }
  325. // 是否包含“值为value”的元素
  326. public boolean containsValue(Object value) {
  327. // 若“value为null”,则调用containsNullValue()查找
  328. if (value == null)
  329. return containsNullValue();
  330. // 若“value不为null”,则查找HashMap中是否有值为value的节点。
  331. Entry[] tab = table;
  332. for (int i = 0; i < tab.length ; i++)
  333. for (Entry e = tab[i] ; e != null ; e = e.next)
  334. if (value.equals(e.value))
  335. return true;
  336. return false;
  337. }
  338. // 是否包含null值
  339. private boolean containsNullValue() {
  340. Entry[] tab = table;
  341. for (int i = 0; i < tab.length ; i++)
  342. for (Entry e = tab[i] ; e != null ; e = e.next)
  343. if (e.value == null)
  344. return true;
  345. return false;
  346. }
  347. // 克隆一个HashMap,并返回Object对象
  348. public Object clone() {
  349. HashMap<K,V> result = null;
  350. try {
  351. result = (HashMap<K,V>)super.clone();
  352. } catch (CloneNotSupportedException e) {
  353. // assert false;
  354. }
  355. result.table = new Entry[table.length];
  356. result.entrySet = null;
  357. result.modCount = 0;
  358. result.size = 0;
  359. result.init();
  360. // 调用putAllForCreate()将全部元素添加到HashMap中
  361. result.putAllForCreate(this);
  362. return result;
  363. }
  364. // Entry是单向链表。
  365. // 它是 “HashMap链式存储法”对应的链表。
  366. // 它实现了Map.Entry 接口,即实现getKey(), getValue(), setValue(V value), equals(Object o), hashCode()这些函数
  367. static class Entry<K,V> implements Map.Entry<K,V> {
  368. final K key;
  369. V value;
  370. // 指向下一个节点
  371. Entry<K,V> next;
  372. final int hash;
  373. // 构造函数。
  374. // 输入参数包括"哈希值(h)", "键(k)", "值(v)", "下一节点(n)"
  375. Entry(int h, K k, V v, Entry<K,V> n) {
  376. value = v;
  377. next = n;
  378. key = k;
  379. hash = h;
  380. }
  381. public final K getKey() {
  382. return key;
  383. }
  384. public final V getValue() {
  385. return value;
  386. }
  387. public final V setValue(V newValue) {
  388. V oldValue = value;
  389. value = newValue;
  390. return oldValue;
  391. }
  392. // 判断两个Entry是否相等
  393. // 若两个Entry的“key”和“value”都相等,则返回true。
  394. // 否则,返回false
  395. public final boolean equals(Object o) {
  396. if (!(o instanceof Map.Entry))
  397. return false;
  398. Map.Entry e = (Map.Entry)o;
  399. Object k1 = getKey();
  400. Object k2 = e.getKey();
  401. if (k1 == k2 || (k1 != null && k1.equals(k2))) {
  402. Object v1 = getValue();
  403. Object v2 = e.getValue();
  404. if (v1 == v2 || (v1 != null && v1.equals(v2)))
  405. return true;
  406. }
  407. return false;
  408. }
  409. // 实现hashCode()
  410. public final int hashCode() {
  411. return (key==null ? 0 : key.hashCode()) ^
  412. (value==null ? 0 : value.hashCode());
  413. }
  414. public final String toString() {
  415. return getKey() + "=" + getValue();
  416. }
  417. // 当向HashMap中添加元素时,绘调用recordAccess()。
  418. // 这里不做任何处理
  419. void recordAccess(HashMap<K,V> m) {
  420. }
  421. // 当从HashMap中删除元素时,绘调用recordRemoval()。
  422. // 这里不做任何处理
  423. void recordRemoval(HashMap<K,V> m) {
  424. }
  425. }
  426. // 新增Entry。将“key-value”插入指定位置,bucketIndex是位置索引。
  427. void addEntry(int hash, K key, V value, int bucketIndex) {
  428. // 保存“bucketIndex”位置的值到“e”中
  429. Entry<K,V> e = table[bucketIndex];
  430. // 设置“bucketIndex”位置的元素为“新Entry”,
  431. // 设置“e”为“新Entry的下一个节点”
  432. table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
  433. // 若HashMap的实际大小 不小于 “阈值”,则调整HashMap的大小
  434. if (size++ >= threshold)
  435. resize(2 * table.length);
  436. }
  437. // 创建Entry。将“key-value”插入指定位置。
  438. void createEntry(int hash, K key, V value, int bucketIndex) {
  439. // 保存“bucketIndex”位置的值到“e”中
  440. Entry<K,V> e = table[bucketIndex];
  441. // 设置“bucketIndex”位置的元素为“新Entry”,
  442. // 设置“e”为“新Entry的下一个节点”
  443. table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
  444. size++;
  445. }
  446. // HashIterator是HashMap迭代器的抽象出来的父类,实现了公共了函数。
  447. // 它包含“key迭代器(KeyIterator)”、“Value迭代器(ValueIterator)”和“Entry迭代器(EntryIterator)”3个子类。
  448. private abstract class HashIterator<E> implements Iterator<E> {
  449. // 下一个元素
  450. Entry<K,V> next;
  451. // expectedModCount用于实现fast-fail机制。
  452. int expectedModCount;
  453. // 当前索引
  454. int index;
  455. // 当前元素
  456. Entry<K,V> current;
  457. HashIterator() {
  458. expectedModCount = modCount;
  459. if (size > 0) { // advance to first entry
  460. Entry[] t = table;
  461. // 将next指向table中第一个不为null的元素。
  462. // 这里利用了index的初始值为0,从0开始依次向后遍历,直到找到不为null的元素就退出循环。
  463. while (index < t.length && (next = t[index++]) == null)
  464. ;
  465. }
  466. }
  467. public final boolean hasNext() {
  468. return next != null;
  469. }
  470. // 获取下一个元素
  471. final Entry<K,V> nextEntry() {
  472. if (modCount != expectedModCount)
  473. throw new ConcurrentModificationException();
  474. Entry<K,V> e = next;
  475. if (e == null)
  476. throw new NoSuchElementException();
  477. // 注意!!!
  478. // 一个Entry就是一个单向链表
  479. // 若该Entry的下一个节点不为空,就将next指向下一个节点;
  480. // 否则,将next指向下一个链表(也是下一个Entry)的不为null的节点。
  481. if ((next = e.next) == null) {
  482. Entry[] t = table;
  483. while (index < t.length && (next = t[index++]) == null)
  484. ;
  485. }
  486. current = e;
  487. return e;
  488. }
  489. // 删除当前元素
  490. public void remove() {
  491. if (current == null)
  492. throw new IllegalStateException();
  493. if (modCount != expectedModCount)
  494. throw new ConcurrentModificationException();
  495. Object k = current.key;
  496. current = null;
  497. HashMap.this.removeEntryForKey(k);
  498. expectedModCount = modCount;
  499. }
  500. }
  501. // value的迭代器
  502. private final class ValueIterator extends HashIterator<V> {
  503. public V next() {
  504. return nextEntry().value;
  505. }
  506. }
  507. // key的迭代器
  508. private final class KeyIterator extends HashIterator<K> {
  509. public K next() {
  510. return nextEntry().getKey();
  511. }
  512. }
  513. // Entry的迭代器
  514. private final class EntryIterator extends HashIterator<Map.Entry<K,V>> {
  515. public Map.Entry<K,V> next() {
  516. return nextEntry();
  517. }
  518. }
  519. // 返回一个“key迭代器”
  520. Iterator<K> newKeyIterator() {
  521. return new KeyIterator();
  522. }
  523. // 返回一个“value迭代器”
  524. Iterator<V> newValueIterator() {
  525. return new ValueIterator();
  526. }
  527. // 返回一个“entry迭代器”
  528. Iterator<Map.Entry<K,V>> newEntryIterator() {
  529. return new EntryIterator();
  530. }
  531. // HashMap的Entry对应的集合
  532. private transient Set<Map.Entry<K,V>> entrySet = null;
  533. // 返回“key的集合”,实际上返回一个“KeySet对象”
  534. public Set<K> keySet() {
  535. Set<K> ks = keySet;
  536. return (ks != null ? ks : (keySet = new KeySet()));
  537. }
  538. // Key对应的集合
  539. // KeySet继承于AbstractSet,说明该集合中没有重复的Key。
  540. private final class KeySet extends AbstractSet<K> {
  541. public Iterator<K> iterator() {
  542. return newKeyIterator();
  543. }
  544. public int size() {
  545. return size;
  546. }
  547. public boolean contains(Object o) {
  548. return containsKey(o);
  549. }
  550. public boolean remove(Object o) {
  551. return HashMap.this.removeEntryForKey(o) != null;
  552. }
  553. public void clear() {
  554. HashMap.this.clear();
  555. }
  556. }
  557. // 返回“value集合”,实际上返回的是一个Values对象
  558. public Collection<V> values() {
  559. Collection<V> vs = values;
  560. return (vs != null ? vs : (values = new Values()));
  561. }
  562. // “value集合”
  563. // Values继承于AbstractCollection,不同于“KeySet继承于AbstractSet”,
  564. // Values中的元素能够重复。因为不同的key可以指向相同的value。
  565. private final class Values extends AbstractCollection<V> {
  566. public Iterator<V> iterator() {
  567. return newValueIterator();
  568. }
  569. public int size() {
  570. return size;
  571. }
  572. public boolean contains(Object o) {
  573. return containsValue(o);
  574. }
  575. public void clear() {
  576. HashMap.this.clear();
  577. }
  578. }
  579. // 返回“HashMap的Entry集合”
  580. public Set<Map.Entry<K,V>> entrySet() {
  581. return entrySet0();
  582. }
  583. // 返回“HashMap的Entry集合”,它实际是返回一个EntrySet对象
  584. private Set<Map.Entry<K,V>> entrySet0() {
  585. Set<Map.Entry<K,V>> es = entrySet;
  586. return es != null ? es : (entrySet = new EntrySet());
  587. }
  588. // EntrySet对应的集合
  589. // EntrySet继承于AbstractSet,说明该集合中没有重复的EntrySet。
  590. private final class EntrySet extends AbstractSet<Map.Entry<K,V>> {
  591. public Iterator<Map.Entry<K,V>> iterator() {
  592. return newEntryIterator();
  593. }
  594. public boolean contains(Object o) {
  595. if (!(o instanceof Map.Entry))
  596. return false;
  597. Map.Entry<K,V> e = (Map.Entry<K,V>) o;
  598. Entry<K,V> candidate = getEntry(e.getKey());
  599. return candidate != null && candidate.equals(e);
  600. }
  601. public boolean remove(Object o) {
  602. return removeMapping(o) != null;
  603. }
  604. public int size() {
  605. return size;
  606. }
  607. public void clear() {
  608. HashMap.this.clear();
  609. }
  610. }
  611. // java.io.Serializable的写入函数
  612. // 将HashMap的“总的容量,实际容量,所有的Entry”都写入到输出流中
  613. private void writeObject(java.io.ObjectOutputStream s)
  614. throws IOException
  615. {
  616. Iterator<Map.Entry<K,V>> i =
  617. (size > 0) ? entrySet0().iterator() : null;
  618. // Write out the threshold, loadfactor, and any hidden stuff
  619. s.defaultWriteObject();
  620. // Write out number of buckets
  621. s.writeInt(table.length);
  622. // Write out size (number of Mappings)
  623. s.writeInt(size);
  624. // Write out keys and values (alternating)
  625. if (i != null) {
  626. while (i.hasNext()) {
  627. Map.Entry<K,V> e = i.next();
  628. s.writeObject(e.getKey());
  629. s.writeObject(e.getValue());
  630. }
  631. }
  632. }
  633. private static final long serialVersionUID = 362498820763181265L;
  634. // java.io.Serializable的读取函数:根据写入方式读出
  635. // 将HashMap的“总的容量,实际容量,所有的Entry”依次读出
  636. private void readObject(java.io.ObjectInputStream s)
  637. throws IOException, ClassNotFoundException
  638. {
  639. // Read in the threshold, loadfactor, and any hidden stuff
  640. s.defaultReadObject();
  641. // Read in number of buckets and allocate the bucket array;
  642. int numBuckets = s.readInt();
  643. table = new Entry[numBuckets];
  644. init(); // Give subclass a chance to do its thing.
  645. // Read in size (number of Mappings)
  646. int size = s.readInt();
  647. // Read the keys and values, and put the mappings in the HashMap
  648. for (int i=0; i<size; i++) {
  649. K key = (K) s.readObject();
  650. V value = (V) s.readObject();
  651. putForCreate(key, value);
  652. }
  653. }
  654. // 返回“HashMap总的容量”
  655. int capacity() { return table.length; }
  656. // 返回“HashMap的加载因子”
  657. float loadFactor() { return loadFactor; }
  658. }

3. 几点总结

1、首先要清楚HashMap的存储结构,如下图所示:

HashMap源码剖析 - 图1

图中,紫色部分即代表哈希表,也称为哈希数组,数组的每个元素都是一个单链表的头节点,链表是用来解决冲突的,如果不同的key映射到了数组的同一位置处,就将其放入单链表中。

2、首先看链表中节点的数据结构:

  1. // Entry是单向链表。
  2. // 它是 “HashMap链式存储法”对应的链表。
  3. // 它实现了Map.Entry 接口,即实现getKey(), getValue(), setValue(V value), equals(Object o), hashCode()这些函数
  4. static class Entry<K,V> implements Map.Entry<K,V> {
  5. final K key;
  6. V value;
  7. // 指向下一个节点
  8. Entry<K,V> next;
  9. final int hash;
  10. // 构造函数。
  11. // 输入参数包括"哈希值(h)", "键(k)", "值(v)", "下一节点(n)"
  12. Entry(int h, K k, V v, Entry<K,V> n) {
  13. value = v;
  14. next = n;
  15. key = k;
  16. hash = h;
  17. }
  18. public final K getKey() {
  19. return key;
  20. }
  21. public final V getValue() {
  22. return value;
  23. }
  24. public final V setValue(V newValue) {
  25. V oldValue = value;
  26. value = newValue;
  27. return oldValue;
  28. }
  29. // 判断两个Entry是否相等
  30. // 若两个Entry的“key”和“value”都相等,则返回true。
  31. // 否则,返回false
  32. public final boolean equals(Object o) {
  33. if (!(o instanceof Map.Entry))
  34. return false;
  35. Map.Entry e = (Map.Entry)o;
  36. Object k1 = getKey();
  37. Object k2 = e.getKey();
  38. if (k1 == k2 || (k1 != null && k1.equals(k2))) {
  39. Object v1 = getValue();
  40. Object v2 = e.getValue();
  41. if (v1 == v2 || (v1 != null && v1.equals(v2)))
  42. return true;
  43. }
  44. return false;
  45. }
  46. // 实现hashCode()
  47. public final int hashCode() {
  48. return (key==null ? 0 : key.hashCode()) ^
  49. (value==null ? 0 : value.hashCode());
  50. }
  51. public final String toString() {
  52. return getKey() + "=" + getValue();
  53. }
  54. // 当向HashMap中添加元素时,绘调用recordAccess()。
  55. // 这里不做任何处理
  56. void recordAccess(HashMap<K,V> m) {
  57. }
  58. // 当从HashMap中删除元素时,绘调用recordRemoval()。
  59. // 这里不做任何处理
  60. void recordRemoval(HashMap<K,V> m) {
  61. }
  62. }

它的结构元素除了key、value、hash外,还有next,next指向下一个节点。另外,这里覆写了equals和hashCode方法来保证键值对的独一无二。

3、HashMap共有四个构造方法。构造方法中提到了两个很重要的参数:初始容量和加载因子。这两个参数是影响HashMap性能的重要参数,其中容量表示哈希表中槽的数量(即哈希数组的长度),初始容量是创建哈希表时的容量(从构造函数中可以看出,如果不指明,则默认为16),加载因子是哈希表在其容量自动增加之前可以达到多满的一种尺度,当哈希表中的条目数超出了加载因子与当前容量的乘积时,则要对该哈希表进行 resize 操作(即扩容)。

下面说下加载因子,如果加载因子越大,对空间的利用更充分,但是查找效率会降低(链表长度会越来越长);如果加载因子太小,那么表中的数据将过于稀疏(很多空间还没用,就开始扩容了),对空间造成严重浪费。如果我们在构造方法中不指定,则系统默认加载因子为0.75,这是一个比较理想的值,一般情况下我们是无需修改的。

另外,无论我们指定的容量为多少,构造方法都会将实际容量设为不小于指定容量的2的次方的一个数,且最大值不能超过2的30次方

4、HashMap中key和value都允许为null。

5、要重点分析下HashMap中用的最多的两个方法put和get。先从比较简单的get方法着手,源码如下:

  1. // 获取key对应的value
  2. public V get(Object key) {
  3. if (key == null)
  4. return getForNullKey();
  5. // 获取key的hash值
  6. int hash = hash(key.hashCode());
  7. // 在“该hash值对应的链表”上查找“键值等于key”的元素
  8. for (Entry<K,V> e = table[indexFor(hash, table.length)];
  9. e != null;
  10. e = e.next) {
  11. Object k;
  12. /判断key是否相同
  13. if (e.hash == hash && ((k = e.key) == key || key.equals(k)))
  14. return e.value;
  15. }
  16. 没找到则返回null
  17. return null;
  18. }
  19. // 获取“key为null”的元素的值
  20. // HashMap将“key为null”的元素存储在table[0]位置,但不一定是该链表的第一个位置!
  21. private V getForNullKey() {
  22. for (Entry<K,V> e = table[0]; e != null; e = e.next) {
  23. if (e.key == null)
  24. return e.value;
  25. }
  26. return null;
  27. }

首先,如果key为null,则直接从哈希表的第一个位置table[0]对应的链表上查找。记住,key为null的键值对永远都放在以table[0]为头结点的链表中,当然不一定是存放在头结点table[0]中。

如果key不为null,则先求的key的hash值,根据hash值找到在table中的索引,在该索引对应的单链表中查找是否有键值对的key与目标key相等,有就返回对应的value,没有则返回null。

put方法稍微复杂些,代码如下:

  1. // 将“key-value”添加到HashMap中
  2. public V put(K key, V value) {
  3. // 若“key为null”,则将该键值对添加到table[0]中。
  4. if (key == null)
  5. return putForNullKey(value);
  6. // 若“key不为null”,则计算该key的哈希值,然后将其添加到该哈希值对应的链表中。
  7. int hash = hash(key.hashCode());
  8. int i = indexFor(hash, table.length);
  9. for (Entry<K,V> e = table[i]; e != null; e = e.next) {
  10. Object k;
  11. // 若“该key”对应的键值对已经存在,则用新的value取代旧的value。然后退出!
  12. if (e.hash == hash && ((k = e.key) == key || key.equals(k))) {
  13. V oldValue = e.value;
  14. e.value = value;
  15. e.recordAccess(this);
  16. return oldValue;
  17. }
  18. }
  19. // 若“该key”对应的键值对不存在,则将“key-value”添加到table中
  20. modCount++;
  21. //将key-value添加到table[i]处
  22. addEntry(hash, key, value, i);
  23. return null;
  24. }

如果key为null,则将其添加到table[0]对应的链表中,putForNullKey的源码如下:

  1. // putForNullKey()的作用是将“key为null”键值对添加到table[0]位置
  2. private V putForNullKey(V value) {
  3. for (Entry<K,V> e = table[0]; e != null; e = e.next) {
  4. if (e.key == null) {
  5. V oldValue = e.value;
  6. e.value = value;
  7. e.recordAccess(this);
  8. return oldValue;
  9. }
  10. }
  11. // 如果没有存在key为null的键值对,则直接题阿见到table[0]处!
  12. modCount++;
  13. addEntry(0, null, value, 0);
  14. return null;
  15. }

如果key不为null,则同样先求出key的hash值,根据hash值得出在table中的索引,而后遍历对应的单链表,如果单链表中存在与目标key相等的键值对,则将新的value覆盖旧的value,比将旧的value返回,如果找不到与目标key相等的键值对,或者该单链表为空,则将该键值对插入到改单链表的头结点位置(每次新插入的节点都是放在头结点的位置),该操作是有addEntry方法实现的,它的源码如下:

  1. // 新增Entry。将“key-value”插入指定位置,bucketIndex是位置索引。
  2. void addEntry(int hash, K key, V value, int bucketIndex) {
  3. // 保存“bucketIndex”位置的值到“e”中
  4. Entry<K,V> e = table[bucketIndex];
  5. // 设置“bucketIndex”位置的元素为“新Entry”,
  6. // 设置“e”为“新Entry的下一个节点”
  7. table[bucketIndex] = new Entry<K,V>(hash, key, value, e);
  8. // 若HashMap的实际大小 不小于 “阈值”,则调整HashMap的大小
  9. if (size++ >= threshold)
  10. resize(2 * table.length);
  11. }

注意这里倒数第三行的构造方法,将key-value键值对赋给table[bucketIndex],并将其next指向元素e,这便将key-value放到了头结点中,并将之前的头结点接在了它的后面。该方法也说明,每次put键值对的时候,总是将新的该键值对放在table[bucketIndex]处(即头结点处)。

另外注意最后两行代码,每次加入键值对时,都要判断当前已用的槽的数目是否大于等于阀值(容量*加载因子),如果大于等于,则进行扩容,将容量扩为原来容量的2倍。

6、关于扩容。上面我们看到了扩容的方法,resize方法,它的源码如下:

  1. // 重新调整HashMap的大小,newCapacity是调整后的单位
  2. void resize(int newCapacity) {
  3. Entry[] oldTable = table;
  4. int oldCapacity = oldTable.length;
  5. if (oldCapacity == MAXIMUM_CAPACITY) {
  6. threshold = Integer.MAX_VALUE;
  7. return;
  8. }
  9. // 新建一个HashMap,将“旧HashMap”的全部元素添加到“新HashMap”中,
  10. // 然后,将“新HashMap”赋值给“旧HashMap”。
  11. Entry[] newTable = new Entry[newCapacity];
  12. transfer(newTable);
  13. table = newTable;
  14. threshold = (int)(newCapacity * loadFactor);
  15. }

很明显,是新建了一个HashMap的底层数组,而后调用transfer方法,将就HashMap的全部元素添加到新的HashMap中(要重新计算元素在新的数组中的索引位置)。transfer方法的源码如下:

  1. // 将HashMap中的全部元素都添加到newTable中
  2. void transfer(Entry[] newTable) {
  3. Entry[] src = table;
  4. int newCapacity = newTable.length;
  5. for (int j = 0; j < src.length; j++) {
  6. Entry<K,V> e = src[j];
  7. if (e != null) {
  8. src[j] = null;
  9. do {
  10. Entry<K,V> next = e.next;
  11. int i = indexFor(e.hash, newCapacity);
  12. e.next = newTable[i];
  13. newTable[i] = e;
  14. e = next;
  15. } while (e != null);
  16. }
  17. }
  18. }

很明显,扩容是一个相当耗时的操作,因为它需要重新计算这些元素在新的数组中的位置并进行复制处理。因此,我们在用HashMap的时,最好能提前预估下HashMap中元素的个数,这样有助于提高HashMap的性能。

7、注意containsKey方法和containsValue方法。前者直接可以通过key的哈希值将搜索范围定位到指定索引对应的链表,而后者要对哈希数组的每个链表进行搜索。

8、我们重点来分析下求hash值和索引值的方法,这两个方法便是HashMap设计的最为核心的部分,二者结合能保证哈希表中的元素尽可能均匀地散列。

计算哈希值的方法如下:

  1. static int hash(int h) {
  2. h ^= (h >>> 20) ^ (h >>> 12);
  3. return h ^ (h >>> 7) ^ (h >>> 4);
  4. }

它只是一个数学公式,IDK这样设计对hash值的计算,自然有它的好处,至于为什么这样设计,我们这里不去追究,只要明白一点,用的位的操作使hash值的计算效率很高。

由hash值找到对应索引的方法如下:

  1. static int indexFor(int h, int length) {
  2. return h & (length-1);
  3. }

这个我们要重点说下,我们一般对哈希表的散列很自然地会想到用hash值对length取模(即除法散列法),Hashtable中也是这样实现的,这种方法基本能保证元素在哈希表中散列的比较均匀,但取模会用到除法运算,效率很低,HashMap中则通过h&(length-1)的方法来代替取模,同样实现了均匀的散列,但效率要高很多,这也是HashMap对Hashtable的一个改进。

接下来,我们分析下为什么哈希表的容量一定要是2的整数次幂。首先,length为2的整数次幂的话,h&(length-1)就相当于对length取模,这样便保证了散列的均匀,同时也提升了效率;其次,length为2的整数次幂的话,为偶数,这样length-1为奇数,奇数的最后一位是1,这样便保证了h&(length-1)的最后一位可能为0,也可能为1(这取决于h的值),即与后的结果可能为偶数,也可能为奇数,这样便可以保证散列的均匀性,而如果length为奇数的话,很明显length-1为偶数,它的最后一位是0,这样h&(length-1)的最后一位肯定为0,即只能为偶数,这样任何hash值都只会被散列到数组的偶数下标位置上,这便浪费了近一半的空间,因此,length取2的整数次幂,是为了使不同hash值发生碰撞的概率较小,这样就能使元素在哈希表中均匀地散列。

原文链接:https://github.com/GeniusVJR/LearningNotes